--------------------------------<tk Pl>--------------------------------

Thank you for trying tk Pl.
If this readme file doesn't help you, please contact the 
btkplayteam in dalnet or phazenet or email your question to:

queries@btkplay.20m.com

If you use tk Pl, please take a few seconds to email us with:

Your name
IRC nick/network/channels
Any suggestions on improvement
Any donations(all proceeds go to charity)
A pic if you have one 
Any other comments

This is by no means mandatory, we just like to see how many people use
tk Pl around the world. Any donations to the team would be greatly 
appreciated, but not expected! We ask for nothing 'cept a pic! lol.

Happy listening ;o)

-------------------------------------------------------------------------

--WHAT IS tk Pl--

tk Pl is a music addon for mIRC. tk Pl allows you to play music in 
channels and while offline.  tk Pl also allows grabbing of .wav and 
.mp3 files and can handle sending to other nicks too.  tk Pl can use 
either mIRCs own internal player or another player of your choice(e.g 
Media Player) for .mp3 files. (NOTE Winamp v3 is currently not compatible)
tk Pl has been tested on mIRC 6.0 and newer, it may or may not work
on earlier versions of mIRC, get the latest at www.mirc.com.

-------------------------------------------------------------------------

--TO LOAD tk Pl--

While in mIRC hold down <alt> and hit R.  In the box that appears
"remotes editor" go to file/load/script.  Make sure the filetype
is set to "Scripts (*.ini, *.mrc)" files or "All files (*.*)" and find the btkplay.mrc file.
Highlight it and click Ok. When asked to initialise click YES.
tk Pl will then proceed to set up.

or

Open the btkplay.mrc file with wordpad, select all and paste into remotes editor.

or

In mIRC type /load -rs DISK:\put\your\path\here\btkplay.mrc
For example /load -rs c:\mirc\btkplay\btkplay.mrc

***IMPORTANT***   Please make sure the all btkplay files are   ***IMPORTANT***
***IMPORTANT*** included in the SAME folder as the main script ***IMPORTANT***

-------------------------------------------------------------------------

--TO USE tk Pl--

Right click your mouse in a channel or nicklist:

Remote Version:
Opens a dialog of all tk Pl commands.
**NOTE** tk Pl 
will only play to the channel the dialog is opened in, to change channels, 
close and reopen the dialog in the new channel.

Classic Version:
Utilises tk Pls Popup controls for commands, This version can play 
in multiple channels.
**NOTE** Different play options must be selected for each 
channel i.e in #channel1 choose random wav play, in #channel2 choose silent
play etc etc

Open Grab Window:
This tk Pl option opens a window which shows a list of all the songs 
played in all the channels you are in, who played them and what channel.
If you double click the song tk Pl will automatically attempt to grab
it for you. 
**NOTE** Will attempt to grab in the network the grab window
was opened in.

Playlist:
Open the playlist window, add the songs you want to hear, hit play, tk Pl
will only play those songs!  tk Pl can Back-to-Back play these songs too!

Back-To-Back Play:
If Back-to-Back play is selected, tk Pl will play your mp3 or wave until 
it ends before starting the next one. Great for those who like to listen to
the whole song! There is no silent option for back-to-back play.

List grabber:
This is not set up during the initial loading of tk Pl. The listgrabber
works, in simple terms, by reading a line in a .txt file and shooting it 
to the channel of your choice.  What most people do is create a blank .txt 
file, mylist.txt for example and simply paste in requests to it.  A request
line should take the form:

!nickname filename-you-are-looking-for.mp3

Many other players put other information in their created lists, this can be 
added to the request line as tk Pl filters the information it needs from
each line, so no need to go through the whole list, deleting parts of lines!!
Once the .txt file is set up, the grabber needs to know 3 things:
1. The name and location of the file you are grabbing from.
2. The channel and network the grabber will be active in.
3. The connection speed. (Please note that if you are on cable/dsl but the 
person you are grabbing from is not, you should choose dialup. Also if
the channel allows fast-grabbing, choose dialup as it triggers the next
grab as the last one completes.)
Now you are ready to begin grabbing, it should be noted that to use the
grabber at its most efficient you will need to set auto-accept of whichever
filetype you are grabbing, it's also a good idea to set the "if file exists" 
option to resume. tk Pl's grabber will now try to grab the next file in 
your grab list automatically when:
a. you enter the correct channel on the correct network.
b. the person to be grabbed from enters the channel in that network.
c. the current file completes download or 2 minutes after the last grab
(depending on connection setting).

Listmaker:
tk Pl will make a list of all your waves and mp3s so that others may view
the files you have, without bothering you to see if you have it, or perhaps to
add it to their own list grabbers. The listmaker works using ms-dos to keep 
mIRC workable. If you have only a few files, then it will look like two black 
flashes to you when the list is made, this is perfectly normal and not to be 
worried about. If you have a lot of files however, a good few thousand, then 
simply minimise the black ms-dos window to return to mIRC, allowing the list 
to be made in the background. Many users of other sound playing scripts say this
is the best and fastest listmaker they have come across. Another good point in 
the tk Pl listmaker is that it automatically updates your list, although it 
is writing a new file, it will delete the last list made, so you dont have 
countless out of date lists building up in one folder. 
The listmaker defaults to the two folders set for .mp3 and .wav files. This
can be changed by typing in any mIRC window:
/set %btkplayfolder disc:/new/wav/path/here/
/set %btkplaymp3folder disc:/new/mp3/path/here/
A larger listmaker is in the process of being written, to include multiple 
folders for each filetype.

Skinz:
When tk Pl first loads up it creates two new files, play and grab skinz.
These are very basic and only have a few default skinz in them. You are free
to add to this file by clicking in the remote version dialog or by opening 
the files and pasting new skinz manually. These are not the only skinz you
need to use, any skinz .txt file can be loaded and used instead. Check out
http://www.geocities.com/allthingsdalnet/
for skinz files. Grab skinz show when you grab a song from the listgrabber or
grab window, play skinz show when you play a wav or mp3 in colour mode.

No-Colour & Private modes:
No Colour mode when selected does not send the colourful messages to the channel
and only the CTCP messages(used by other players for grab window detection
or auto voicing etc.) the "Now Playing" line that you see is visible to you
ONLY. Private mode is similar, but for use in channels where shooting CTCPs is
not allowed, again only you see the message. This option was added to tk Pl
as more and more people are wanting a simple player for smaller channels.

-------------------------------------------------------------------------

--IS IT POSSIBLE TO PLAY SONGS EVEN WHEN I AM OFFLINE?--

Yes, if mIRC is open but not connected, you can right click in the status 
window to bring up a compact, quick and easy version of tk Pl.
This version is just a simple player with no frills. It only uses mIRC's 
own internal player.  If you are looking for a song and it's not in the 
offline tk Pl dialog, try classic version, this allows you to explore
your machine and find the song you want. Remote version in tk Pl-offline
is set up to show only songs from the folders set for .wav and .mp3

-------------------------------------------------------------------------

--I HAVE A PREVIOUS VERSION OF tk Pl, CAN I UPDATE?--

Yes.  Please remember to set things like you want, i.e. skinz file etc.
If you have set up the list grabber before, your settings will remain when 
you load the new version.  Check for updates regularly on the btkplay website:
www.geocities.com/btkplay/downloads/ 
or any of our mirror sites, listed at the end of this document.
The auto update feature was removed from tk Pl due to it being impossible
to know what needed updated from version to version in earlier versions.
this is being streamlined at the moment and should be operational again as 
soon as possible.

-------------------------------------------------------------------------

--HOW CAN I CONTACT tk Pl?--

Click the last tab in the remote version, all the contact info is there, and
should automatically set it all up for you. If not our email address is at 
the top and bottom of this document. 

-------------------------------------------------------------------------
-------------------------------------------------------------------------

Updates :

1) Silent play now wont interfere with any other tunes from playing.
2) Grab window now clearable. 
3) Grab window highlights whats been grabbed but does not delete the line in 
	case send fails. 
4) New Titlebar Display.
5) Now supports external mp3 player. 
6) New loading countdown.
7) Fixed bug that caused black box to sometimes appear in play skinz.
8) Back to back mp3 random play. 
9) Mp3 ctcps now changed from SOUND to MP3 whether using mirc or external 
	player.
10) Advertisement to nick or channel including automatic send and load 
	information.
11) Player now appears in nicklist popups too.
12) Added quick contact email option.
13) New layout in the menus.
14) Bug that sent filepath in ctcp fixed.
15) New Playlist option with silent timed, regular timed, and back to back 
	play options.
16) Files sent thru tkPl counter.
17) Deleted popup silent play for external player, option wasn't enabled 
	or needed!
18) Now has optional dialog control.
19) Bug fix in playlist now sends to specific chan instead of active window.
20) Fixed incompatability bug for older mIRCs.
21) Fixed grab window to include filenames with spaces in them.
22) Added offline play feature.
23) Added random colour throughout.
24) Added auto update feature which allows users to update to newer versions 
	of tkPl without need for re-setting of current settings.
25) Changed the way @find looks for songs, now sets to main mirc folder(and 
	its sub-directories) on load and can be changed to any directory. This 
	should help get rid of the lag that sometimes happened during @find sending.
26) Fixed bug that made Back-to-Back play go wierd!.
27) Added quick registration box.
28) Help file!!
29) Added new tk Pl icon.
30) Distribution now in .zip format.(for the Icon and ReadMe file)
31) Added network and channel specific list grabber to channel menu.
32) Removed credits titlebar animation.
33) Added back-to-Back wave play in classic, remote and playlist. Playlist 
	Back-to-Back play can be mixed waves and MP3s now.
34) Added remote control dialog to grabber.
35) Added horizontal layout for Remote version.
36) Added auto grab when the person you are grabbing from enters the grab channel.
37) Added notice for people who try to @find or request in DALnet, in accordance 
	with their new policy (Effective March 1, 2003 DALnet will be enforcing a 
	change to its Acceptable Use Policy (http://www.dal.net/aup) which will 
	prohibit "Using a channel for the primary purpose of facilitating the transfer 
	of files".).
38) Removed most titlebar animations/reminders.
39) Added filename with spaces handling for @finds.
40) Added listmaker * Neoknight *
41) "Hid" ctcps from channel/status.
42) Fixed bug that gave error when back-to-back playlist closed then back to back 
	regular play attempted.
43) Fixed sending for filenames with spaces in them.
44) Fixed @find method to react to "@find song with no asterisks" 
45) Changed what the grabber sends to channel so that it will only send the request
	and not any info that may be in the list, filesize, bitrate etc.
46) Bug fix in grabber that meant if a wav or mp3 get completed it would delete the 
	next line in the grab list, even if it was not the proper sound! Now only 
	deletes the line and moves on if the song finished get is the same as the 
	song on the grab line.
47) Removed listmaker due to bugs. It WILL be here soon.
48) Added filelist to playlist for easy selection, also multi-line adding/deleting.
49) Added listmaker(Temporary) til we can get the stoopid thing sorted out! 
50) Added "Now Playing" info box in playlist.
51) Removed the registration stuff, it was annoying! lol.
52) Added Final Listmaker.
53) Fixed bug in list grabber that meant files sent from people who have fill spaces
	checked, would not activate the grabber on completion.
55) Added dialog'd offline player.
56) Removed original Remote version because it was too bulky looking.
57) Set all files to be in the $scriptdir (btkplayfolder) so it is self-contained.
58) Changed main dialog title display to show in which channel and server it is active.
59) Changed main dialog code slightly to show if you are turning ON/OFF buttons, 
	instead of guessing what they are set to.
60) Changed some coding for the grab window, now only shows files not in the wav or 
	mp3 folder already.
61) Removed playlist "OK" button, this means the playlist willl no longer work in 
	older mIRCs, this was felt necessary to stop the dialog from closing.
62) Added tk Pl customisable external skin files support, due to skinz now being 
	made available in http://www.geocities.com/allthingsdalnet/ thanks to hugzzz.
63) Removed "OK" button in main dialog and added titlebar animation for main dialog.

---Version 5.0---Apr 10th 2003---
64) Added version and dates to readme file for fixes/additions.
65) Bug fix that set grab skinz to the play skinz file on load.
66) Removal of auto-update feature for new downloads due to too many new variables 
	and settings, this means each new loading sets defaults, will re-integrate 
	this feature at a later date. 
67) Bug fix that didnt turn off back-to-back random if you went from that to 
	back-to-back playlist.
68) Slight bug fix that hides the 'sorry sends are off' message from showing.

---Version 5.0.1---Apr 11th 2003---
69) Added compatability of wavget. Plays from wavget now show in grab window.
70) Fixed scripting error that made most options in 5.0 inaccessible.

---Version 5.0.2---Apr 20th 2003---
71) Removed %btkplayfolder variable in place of %btkplayfindfolder as this is
	settable and also the directory used in @find handling(if enabled).
72) Added tkPl Filefinder Addon v1.0, simple part of the script which
	allows the user to search for songs/files using keywords, then play them to
	channel or delete the file.
73) Removed the +/-xxxxGMT part from listmaker advert.

---Version 5.1---Apr 24th 2003---
74) Added dbl click play to filefinder.
75) Fixed some bugs due to the %btkplayfolder being inactivated.(Please email any bugs
	to queries@btkplay.20m.com )
76) Fixed bug in offline/status player not playing wavs if an mp3 is currently playing
	and vice versa.
77) Finally added offline playlist, similar to regular one, though echos to status 
	and no ctcps or errors, so far!

---Version 5.2---May 17th 2003---
78) Updated listmaker to include zip files and also now supports multi-directories and 
	drives (no paths with spaces).
79) Added Self-Closing to list grabber remote control when last file sownload completes.
80) Changed Filefinder colouring and result display to not clash with anyones colour  
	scheme for listboxes.
81) New icon.

---Version 5.21---May 18th 2003---
82) Bug-fix causing endless loop on playlists when not stopped before closing.
83) Updated email addresses-please note old hotmail address no longer in use.

-------------------------------------------------------------------------
-------------------------------------------------------------------------

The tk Pl team are:

billythekid  - email tex@btkplay.20m.com
ShOrT-CiRcUiT - email sc@btkplay.20m.com
Neoknight - email neo@btkplay.20m.com

Latest Updates available from:

www.geocities.com/btkplay
www.btkplay.20m.com 		<-- Under construction
www.btkplay.scriptmania.com	<-- Under construction

General enquiries to:
billythekid  *PhaZeNet*
ShOrT-CiRcUiT *PhaZeNet*
Neoknight *PhaZeNet*

emails:      
queries@btkplay.20m.com
billy@btkplay.20m.com
shortcircuit@btkplay.20m.com
neo@btkplay.20m.com


------------------------------------------------------------------------
------------------------------------t------------------------------------
------------------------------------k------------------------------------
